SM-118 Staking Power #161

JCSanPedro · 2024-01-17T20:37:10Z

The changes in this PR include using the SeekerPowerOracle to determine a Seeker's staking capacity. It introduces a new method to the staking manager calculateCapacityFromSeekerPower that first queries a Seeker's power level then uses that value to determine it's staking capacity. The current algorithm is as follows:

staking_capacity = seeker_power ** seeker_power_multiplier

Seeker power multipler is a constant that we can change through a setter. This will give us flexibility post deployment.

The Directory contract has been updated to call calculateCapacityFromSeekerPower when a node joins an epoch. The maximum amount of stake the node can join an epoch with will also be determined by the staking capacity value. The maximum joined stake cannot exceed either seeker stake cap, or the minimum stake proportion stake. However for the next release, we will set the min staking proportion value to a very low number (1/10000). This requires a change in the percentage denominator to go from a uint16 value to a uint32 value.

The deployment script has also been updated to support deploying the SeekerPowerOracle contract.

teinnt

Awesome, mostly ready to me!

contracts/staking/Directory.sol

teinnt · 2024-01-18T00:38:46Z

contracts/staking/StakingManager.sol


    function initialize(
        IERC20 token,
        RewardsManager rewardsManager,
        EpochsManager epochsManager,
+        ISeekerPowerOracle seekerPowerOracle,


Hmm, is it inconsistent that we take other contracts as classes, but take the oracle as interface? Should we do the same for all of them?

teinnt · 2024-01-18T00:43:08Z

contracts/staking/StakingManager.sol

@@ -17,6 +18,10 @@ import "../interfaces/staking/IStakingManager.sol";
 * and delegated stakers are rewarded on a pro-rata basis.
 */
 contract StakingManager is IStakingManager, Initializable, Ownable2StepUpgradeable, ERC165 {
+    // The maximum possible SYLO that exists in the network. Naturally
+    // represents the maximum possible SYLO that can be staked.
+    uint256 internal constant MAX_SYLO = 10_000_000_000 ether;


I see this contract imports Utils, should we import this constant from Utils?

teinnt · 2024-01-18T00:47:23Z

test/staking.test.ts

    ).to.be.revertedWithCustomError(directory, 'NoStakeToJoinEpoch');
  });

  it('cannot join directory with invalid arguments', async () => {
    await directory.addManager(owner);
    await expect(
-      directory.joinNextDirectory(ethers.ZeroAddress),
+      directory.joinNextDirectory(ethers.ZeroAddress, 1),


Suggested change

directory.joinNextDirectory(ethers.ZeroAddress, 1),

directory.joinNextDirectory(ethers.ZeroAddress, defaultSeekerId),

Did you miss this comment?

teinnt · 2024-01-18T00:49:06Z

test/staking.test.ts

+  });
+
+  it('returns maximum SYLO amount if seeker power is very large', async () => {
+    const maxSylo = ethers.parseEther('10000000000');


Should we create a constant for this?

teinnt · 2024-01-18T00:51:57Z

test/staking.test.ts

+    const maxSylo = ethers.parseEther('10000000000');
+
+    // 1 more than the maximum sylo
+    await seekerPowerOracle.registerSeekerPowerRestricted(111, maxSylo + 1n);


I think it is not needed when the below we have tested it with Math.sqrt right?

This is also tested because we want to avoid multiplying the power if it would cause an overflow

teinnt · 2024-01-18T00:56:37Z

test/staking.test.ts

+  it('joins directory with stake where maximum is dependent on seeker power', async () => {
+    const stakeToAdd = ethers.parseEther('1000000');
+
+    await token.approve(stakingManager.getAddress(), stakeToAdd);
+    await stakingManager.addStake(stakeToAdd, owner);
+
+    // the added stake is 1,000,000 SYLO, but the seeker power capacity
+    // is 490,000 SYLO.
+    await seekerPowerOracle.registerSeekerPowerRestricted(111, 700);
+
+    await directory.addManager(owner);
+    await directory.joinNextDirectory(owner, 111);
+
+    const joinedStake = await directory.getTotalStakeForStakee(1, owner);
+
+    expect(joinedStake).to.equal(ethers.parseEther('490000'));
+  });


That is very niceeeee 🚀

Btw, should we have a test case that the stake amount is effected by both of the seekerCapaciity and stakingProportion?

teinnt · 2024-01-18T01:25:22Z

Btw, I don't see any deployment and ganache contracts update in this PR. Is it missing the last commit?

teinnt

Lovely!

teinnt · 2024-02-20T00:26:06Z

contracts/Registries.sol

-    function setDefaultPayoutPercentage(uint16 _defaultPayoutPercentage) external onlyOwner {
-        if (_defaultPayoutPercentage > 10000) {
-            revert PercentageCannotExceed10000();
+    function setDefaultPayoutPercentage(uint32 _defaultPayoutPercentage) external onlyOwner {


Let's update the comment above too. Also comments in percOf, asPerc, setDecayRate, minimumStakeProportion.

* denominator is 100000.

teinnt · 2024-02-20T01:01:10Z

contracts/staking/StakingManager.sol

+        // If the Seeker Power is already
+        // at the maximum sylo, then we just return the max sylo value directly.


Suggested change

// If the Seeker Power is already

// at the maximum sylo, then we just return the max sylo value directly.

// If the Seeker Power is already at the maximum sylo, then we just

// return the max sylo value directly.

teinnt · 2024-02-20T01:04:24Z

deploy/001_deploy_contracts.ts

-    case 'porcini-testing':
-      return configs.PorciniTestingParameters;


Why do we remove config testing?

We just haven't been using it. Adds confusion if you select the wrong one.

teinnt · 2024-02-20T01:08:46Z

deploy/001_deploy_contracts.ts

+    {
+      name: ContractNames.seekerPowerOracle,
+      args: [config.SeekerPowerOracle.oracleAccount],
+    },


Will this a precompiled contract like Seekers or SyloToken, or it will belong to our contract set

It is one of our deployed contracts

teinnt · 2024-02-20T01:09:01Z

deployments/ganache_deployment_phase_two.json

+ "seekers": "0x49C537a88016186Ef41713239799Fc975F9e9aFA",
+ "seekerPowerOracle": "0xca7efb9aA54e70F7a8e7efb878A48BaefA34F4AC",
+ "futurepassRegistrar": "0x7DBf77bb534997892e5Bcfbdc79Dd82E71C35245"
+}


Should we add the last line here?

teinnt · 2024-02-20T01:13:23Z

deployments/genesis.config.ts

+  },
+
+  SeekerPowerOracle: {
+    oracleAccount: '',


Since this can be empty, should we check for zero address here?

teinnt · 2024-02-20T01:18:08Z

deployments/genesis.config.ts

+  },
+
+  SeekerPowerOracle: {
+    oracleAccount: '0x835dF5fE77D479695a616F79A3FC3a25310eb7c6',


Suggested change

oracleAccount: '0x835dF5fE77D479695a616F79A3FC3a25310eb7c6',

oracleAccount: '0x835dF5fE77D479695a616F79A3FC3a25310eb7c6', // deployer

teinnt · 2024-02-20T01:20:36Z

test/staking.test.ts

    ).to.be.revertedWithCustomError(directory, 'NoStakeToJoinEpoch');
  });

  it('cannot join directory with invalid arguments', async () => {
    await directory.addManager(owner);
    await expect(
-      directory.joinNextDirectory(ethers.ZeroAddress),
+      directory.joinNextDirectory(ethers.ZeroAddress, 1),


Did you miss this comment?

teinnt · 2024-02-20T02:59:35Z

test/staking.test.ts

+
+    const joinedStake = await directory.getTotalStakeForStakee(1, owner);
+
+    expect(joinedStake).to.equal(ethers.parseEther('4000000'));


I was thinking, should we have an event when the staking amount is deducted, so that we or user can query it when needed?

It's already possible to see the amount of stake the node joined the directory with

teinnt · 2024-02-20T03:04:05Z

contracts/staking/Directory.sol

+        if (totalStake > seekerStakingCapacity && totalStake > minProportionStakingCapacity) {
+            joiningStake = Math.min(seekerStakingCapacity, minProportionStakingCapacity);
+        } else if (totalStake > seekerStakingCapacity) {
+            joiningStake = seekerStakingCapacity;
+        } else if (totalStake > minProportionStakingCapacity) {
+            joiningStake = minProportionStakingCapacity;
+        } else { // uncapped


Can we use switch case?

I don't think there is a switch case in solidity?

…tory

teinnt reviewed Jan 18, 2024

View reviewed changes

JCSanPedro force-pushed the SM-118-staking-power branch from d96cae6 to f3a0e2f Compare February 16, 2024 03:35

teinnt previously approved these changes Feb 20, 2024

View reviewed changes

teinnt reviewed Feb 20, 2024

View reviewed changes

JCSanPedro dismissed teinnt’s stale review via ea9c164 February 20, 2024 03:25

JCSanPedro force-pushed the SM-118-staking-power branch from ea9c164 to aa13035 Compare February 20, 2024 03:26

JCSanPedro added 10 commits February 20, 2024 16:28

implement calculateCapacityFromSeekerPower and use when joining direc…

bf498e4

…tory

add test for seeker staking capacity

eaf0d27

update deployment script to deploy SeekerPowerOracle

76baca5

update capacity calculation to use simple multiplier

a385e76

simplify directory stake capacity algorithm

d37e564

update percentage denominator to 100000

85f1369

add seeker power multipler argument to staking manager deployment

708bc79

update default payout perc and decay rate param types

b40bd31

correct comments

6b2ccca

ensure oracle cannot be initialized with zero address

ea6f0cf

JCSanPedro force-pushed the SM-118-staking-power branch from aa13035 to ea6f0cf Compare February 20, 2024 03:29

teinnt approved these changes Feb 20, 2024

View reviewed changes

teinnt merged commit 7656d31 into master Feb 20, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SM-118 Staking Power #161

SM-118 Staking Power #161

JCSanPedro commented Jan 17, 2024 •

edited

Loading

teinnt left a comment •

edited

Loading

teinnt Jan 18, 2024

teinnt Jan 18, 2024

teinnt Jan 18, 2024

teinnt Feb 20, 2024

teinnt Jan 18, 2024

teinnt Jan 18, 2024

JCSanPedro Feb 16, 2024

teinnt Jan 18, 2024

teinnt Jan 18, 2024

teinnt commented Jan 18, 2024 •

edited

Loading

teinnt left a comment

teinnt Feb 20, 2024

teinnt Feb 20, 2024

teinnt Feb 20, 2024

JCSanPedro Feb 20, 2024

teinnt Feb 20, 2024

JCSanPedro Feb 20, 2024

teinnt Feb 20, 2024

teinnt Feb 20, 2024

teinnt Feb 20, 2024

teinnt Feb 20, 2024

teinnt Feb 20, 2024

JCSanPedro Feb 20, 2024

teinnt Feb 20, 2024

JCSanPedro Feb 20, 2024

	directory.joinNextDirectory(ethers.ZeroAddress, 1),
	directory.joinNextDirectory(ethers.ZeroAddress, defaultSeekerId),

		// If the Seeker Power is already
		// at the maximum sylo, then we just return the max sylo value directly.

		case 'porcini-testing':
		return configs.PorciniTestingParameters;

	oracleAccount: '0x835dF5fE77D479695a616F79A3FC3a25310eb7c6',
	oracleAccount: '0x835dF5fE77D479695a616F79A3FC3a25310eb7c6', // deployer


		const joinedStake = await directory.getTotalStakeForStakee(1, owner);

		expect(joinedStake).to.equal(ethers.parseEther('4000000'));

SM-118 Staking Power #161

SM-118 Staking Power #161

Conversation

JCSanPedro commented Jan 17, 2024 • edited Loading

teinnt left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

teinnt commented Jan 18, 2024 • edited Loading

teinnt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JCSanPedro commented Jan 17, 2024 •

edited

Loading

teinnt left a comment •

edited

Loading

teinnt commented Jan 18, 2024 •

edited

Loading